Skip to content

设置异步日志 - LogSetAsync

函数简介

设置是否启用异步日志模式,异步模式可以提高性能。

接口名称

LogSetAsync

DLL调用

c
int32_t LogSetAsync(int64_t instance, int64_t loggerHandle, int32_t enableAsync);

参数说明

参数名类型说明
instance长整数型OLAPlug对象的指针,由 CreateCOLAPlugInterFace 接口生成。
loggerHandle长整数型日志实例句柄(0 表示默认实例)。
enableAsync整数型是否启用异步日志(1 启用,0 禁用)。

示例

启用异步后建议设 LogSetFlushInterval,关键路径用 LogFlush 落盘。

SDK 调用

cpp
#include "OLAPlugServer.h"

OLAPlugServer ola;
const int64_t logger = 0; // 默认实例

int ret = ola.LogSetAsync(logger, 1); // enable async
if (ret != 1) {
    return;
}
ola.LogSetFlushInterval(logger, 3); // 3 秒自动刷新
ola.LogInfo("async logging on");
ola.LogFlush(logger); // 立即落盘
csharp
using System;
using OLAPlug;

var ola = new OLAPlugServer();
long logger = 0;

int ret = ola.LogSetAsync(logger, 1); // enable async
if (ret != 1) return;
ola.LogSetFlushInterval(logger, 3); // 3 秒自动刷新
ola.LogInfo("async logging on");
ola.LogFlush(logger); // 立即落盘
python
from OLAPlugServer import OLAPlugServer

ola = OLAPlugServer()
logger = 0

ret = ola.LogSetAsync(logger, 1)  # enable async
if ret != 1:
    raise RuntimeError("failed")
ola.LogSetFlushInterval(logger, 3)  # 3 秒自动刷新
ola.LogInfo("async logging on")
ola.LogFlush(logger)  # 立即落盘
java
import com.olaplug.OLAPlugServer;

OLAPlugServer ola = new OLAPlugServer();
long logger = 0;

int ret = ola.LogSetAsync(logger, 1); // enable async
if (ret != 1) {
    return;
}
ola.LogSetFlushInterval(logger, 3); // 3 秒自动刷新
ola.LogInfo("async logging on");
ola.LogFlush(logger); // 立即落盘
go
import "github.com/ola/olaplug/olaplug"

ola, _ := olaplug.NewOLAPlugServer("OLAPlug_x64.dll")
defer ola.ReleaseObj()
logger := int64(0)

ret := ola.LogSetAsync(logger, 1) // enable async
if ret != 1 {
    return
}
ola.LogSetFlushInterval(logger, 3) // 3 秒自动刷新
ola.LogInfo("async logging on")
ola.LogFlush(logger) // 立即落盘
rust
use olaplug::OLAPlugServer;

let ola = OLAPlugServer::new("OLAPlug_x64.dll").unwrap();
let logger = 0i64;

let ret = ola.log_set_async(logger, 1); // enable async
if ret != 1 {
    return;
}
ola.log_set_flush_interval(logger, 3); // 3 秒自动刷新
ola.log_info("async logging on");
ola.log_flush(logger); // 立即落盘
cpp
var ola = com("OlaPlug.OlaSoft")
var logger = 0

var ret = ola.LogSetAsync(logger, 1) // enable async
if(ret == 1) {
    ola.LogSetFlushInterval(logger, 3) // 3 秒自动刷新
    ola.LogInfo("async logging on")
    ola.LogFlush(logger) // 立即落盘
}
vbscript
Set ola = CreateObject("OlaPlug.OlaSoft")
logger = 0

ret = ola.LogSetAsync(logger, 1)
If ret = 1 Then
    ola.LogSetFlushInterval logger, 3
    ola.LogInfo "async logging on"
    ola.LogFlush logger
End If
text
.局部变量 ola, OLAPlug
.局部变量 ret, 整数型
.局部变量 logger, 长整数型

ola.Create ()
logger = 0

ret = ola.LogSetAsync (logger, 1)  ' enable async
.如果真 (ret = 1)
    ola.LogSetFlushInterval (logger, 3)  ' 3 秒自动刷新
    ola.LogInfo (“async logging on”)
    ola.LogFlush (logger)  ' 立即落盘
.如果真结束
aardio
import OLAPlugServer;
var ola = OLAPlugServer();
var logger = 0;

var ret = ola.LogSetAsync(logger, 1); // enable async
if(ret == 1){
    ola.LogSetFlushInterval(logger, 3); // 3 秒自动刷新
    ola.LogInfo("async logging on");
    ola.LogFlush(logger); // 立即落盘
}
text
变量 ola <类型 = OLAPlugServer>
ola = 新建 OLAPlugServer
长整数 logger = 0

整数 ret = ola.LogSetAsync(logger, 1)  ' enable async
如果真 (ret = 1)
{
    ola.LogSetFlushInterval(logger, 3)  ' 3 秒自动刷新
    ola.LogInfo("async logging on")
    ola.LogFlush(logger)  ' 立即落盘
}
cpp
#include "OLAPlugServer.h"

OLAPlugServer ola;
int64_t logger = 0;

int32_t ret = ola.LogSetAsync(logger, 1); // enable async
if (ret != 1) {
    return;
}
ola.LogSetFlushInterval(logger, 3); // 3 秒自动刷新
ola.LogInfo("async logging on");
ola.LogFlush(logger); // 立即落盘

原生 DLL 调用

cpp
long instance = CreateCOLAPlugInterFace();
long logger = 0;

int ret = LogSetAsync(instance, logger, 1);
if (ret != 1) {
    return;
}
LogSetFlushInterval(instance, logger, 3);
LogInfo(instance, "async logging on");
LogFlush(instance, logger);
csharp
using System.Runtime.InteropServices;

[DllImport("OLAPlug_x64.dll", CallingConvention = CallingConvention.StdCall)]
static extern long CreateCOLAPlugInterFace();
[DllImport("OLAPlug_x64.dll", CallingConvention = CallingConvention.StdCall)]
static extern int LogSetAsync(long ola, long loggerHandle, int enableAsync);
[DllImport("OLAPlug_x64.dll", CallingConvention = CallingConvention.StdCall)]
static extern int LogSetFlushInterval(long ola, long loggerHandle, int flushIntervalSeconds);
[DllImport("OLAPlug_x64.dll", CallingConvention = CallingConvention.StdCall)]
static extern int LogInfo(long ola, string message);
[DllImport("OLAPlug_x64.dll", CallingConvention = CallingConvention.StdCall)]
static extern int LogFlush(long ola, long loggerHandle);

long instance = CreateCOLAPlugInterFace();
long logger = 0;

int ret = LogSetAsync(instance, logger, 1);
if (ret != 1) return;
LogSetFlushInterval(instance, logger, 3);
LogInfo(instance, "async logging on");
LogFlush(instance, logger);
python
from ctypes import CDLL, c_int, c_int64

ola = CDLL("OLAPlug_x64.dll")
ola.CreateCOLAPlugInterFace.restype = c_int64
instance = ola.CreateCOLAPlugInterFace()
logger = 0

ret = ola.LogSetAsync(instance, logger, 1)
if ret != 1:
    raise RuntimeError("LogSetAsync failed")
ola.LogSetFlushInterval(instance, logger, 3)
ola.LogInfo(instance, b"async logging on")
ola.LogFlush(instance, logger)

返回值

返回值说明
1成功。
0失败。

注意事项

项目说明
默认值1(异步模式)。
异步模式性能更高异步模式性能更高,不会阻塞主线程,但程序崩溃时可能丢失部分日志。
同步模式日志立即写入不会丢失同步模式日志立即写入不会丢失,但性能较低。
修改后立即生效修改后立即生效,如果日志系统已初始化,会自动重新初始化。
建议生产环境使用异步模式,调试环境使用同步模式。